Skip to content

Conversation

@edgchen1
Copy link
Contributor

@edgchen1 edgchen1 commented Jan 5, 2021

Description
Add some initial documentation for the CUDA EP with some details about configuration options.
Update Nuphar EP documentation usage of deprecated set_nuphar_settings() function.

Motivation and Context
Needed somewhere to document CUDA EP provider-specific options.
Deprecation of Python global configuration functions.


# CUDA Execution Provider

The CUDA Execution Provider enables hardware accelerated computation on CUDA-enabled GPUs.
Copy link
Member

@jywu-msft jywu-msft Jan 5, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"computation on Nvidia GPUs" might be better? #Resolved

For build instructions, please see the [BUILD page](../../how-to/build.md#CUDA).

## Configuration Options
The CUDA EP supports the following configuration options:
Copy link
Member

@jywu-msft jywu-msft Jan 5, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would it be possible to link to some sample usage in C++/python etc. ? #Resolved

The device ID.

### cuda_mem_limit
The memory limit of the device memory arena in bytes.
Copy link
Contributor

@pranavsharma pranavsharma Jan 5, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This might need more clarification based on this question #6215. #Resolved

@edgchen1 edgchen1 changed the title Initial CUDA EP documentation. EP documentation updates Jan 6, 2021
@edgchen1 edgchen1 requested a review from ke1337 January 6, 2021 21:56
Copy link
Contributor

@ke1337 ke1337 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit:

The device ID.

### cuda_mem_limit
The size limit of the device memory arena in bytes. This size limit is only for the execution provider's arena. The total device memory usage may be higher.
Copy link
Member

@hariharans29 hariharans29 Jan 8, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for adding another comment. Maybe it is worth specifying the "default" values for each of these parameters ? For example, reading the doc, I understand what the valid values for cudnn_conv_algo_search are and what each option means. What is hard to parse is the "default" value for each. #Resolved

@natke natke merged commit da44699 into gh-pages Jan 13, 2021
@natke natke deleted the edgchen1/cuda_ep_doc branch January 13, 2021 21:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants